# Configuration file for the Sphinx documentation builder.
#
# This file only contains a selection of the most common options. For a full
# list see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html

# -- Path setup --------------------------------------------------------------

# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
import os
import sys
sys.path.insert(0, os.path.abspath('..'))


# -- Project information -----------------------------------------------------

project = 'MechDriver'
copyright = '2023, Sarah Elliott'
author = 'Sarah Elliott'


# -- General configuration ---------------------------------------------------

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
    'sphinx.ext.autodoc',
    'sphinxcontrib.bibtex',  # Needs pip install sphinxcontrib-bibtex
    'sphinx_design'
]
master_doc = 'index'
autodoc_member_order = 'bysource'
autodoc_mock_imports = [
    'numpy', 'scipy', 'pandas',
    'autofile',
    'automol',
    'autorun', 'phydat', 'ioformat', 'autoparse',
    'elstruct', 'chemkin_io', 'mess_io', 'projrot_io', 'onedmin_io',
    'mechanalyzer', 'ratefit', 'thermfit'
]

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

# Add bibliography files
bibtex_bibfiles = ['rst/refs.bib']

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']


# -- Options for HTML output -------------------------------------------------

# The theme to use for HTML and HTML Help pages.  See the documentation for
# a list of builtin themes.
#
html_theme = 'alabaster'
html_logo = 'logo.png'
html_style = 'css/automech.css'
html_sidebars = { '**': ['globaltoc.html', 'relations.html', 'sourcelink.html', 'searchbox.html'] }

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
